Image To Text

This API detects content in an image and converts it into text.

Header Parameters

Content-Type string
The content type should be application/json.
Example: application/json
x-client string
Specifies the client name
Example: jiocoupons
Authorization string required

API key for authorization.

application/json

Request Body

image object

content string required

The base64 encoded image content.

Responses

• 200
• 400
• 401
• 422

---

Detection success

application/json

Schema

Example (from schema)

Example

---

Schema

description string

The detected and translated text from the image.

locale string

The locale of the detected text.

bounding_coordinates object[]
Array [
description string
coordinates array[]
]

{
  "description": "string",
  "locale": "string",
  "bounding_coordinates": [
    {
      "description": "string",
      "coordinates": [
        [
          "..."
        ]
      ]
    }
  ]
}

{
  "description": "Bangla\nকেমন আছ তুমি আজ\nঅফিসে যাচ্ছ?\nKēmana ācha tumi āja aphisē\nyāccha?",
  "locale": "bn",
  "bounding_coordinates": [
    {
      "description": "Bangla",
      "coordinates": [
        [
          127,
          85
        ],
        [
          213,
          85
        ],
        [
          213,
          109
        ],
        [
          127,
          109
        ]
      ]
    }
  ]
}

Bad Request

application/json

Schema

Example (from schema)

Example

---

Schema

status string

Status of the API

message string

The error message of the API

{
  "status": "string",
  "message": "string"
}

{
  "status": "failed",
  "message": "Bad Request"
}

Unauthorized

application/json

Schema

Example (from schema)

Example

---

Schema

status string

Status of the API

message string

The error message of the API

{
  "status": "string",
  "message": "string"
}

{
  "status": "Unauthorized"
}

Unprocessable Entity

application/json

Schema

Example (from schema)

Example

---

Schema

customCode number

Status of the API

message string

The error message of the API

errorsArray Array

The errors array which includes objects with a "property" and "message" properties describing the error

{
  "customCode": 0,
  "message": "string"
}

{
  "customCode": 422,
  "message": "Validation Error",
  "errorsArray": []
}

Loading...